/*
 * 代号：凤凰
 * http://www.jphenix.org
 * 2022年8月21日
 * V4.0
 */
package com.jphenix.standard.servlet.api;

import com.jphenix.standard.docs.ClassInfo;

/**
 * 会话配置信息类
 * 
 * 2022-09-04 隔离了ServletApi，兼容新老Tomcat
 * 
 * @author MBG
 * 2022年8月21日
 */
@ClassInfo({"2022-09-04 21:58","会话配置信息类"})
public interface ISessionCookieConfig {

	/**
	 * 设置会话名
	 * @param name 会话名
	 * 2022年8月21日
	 * @author MBG
	 */
	void setName(String name);

	/**
	 * 返回会话名
	 * @return 会话名
	 * 2022年8月21日
	 * @author MBG
	 */
	String getName();

	/**
	 * 设置域
	 * @param domain 域
	 * 2022年8月21日
	 * @author MBG
	 */
	void setDomain(String domain);

	/**
	 * 获取域
	 * @return 域
	 * 2022年8月21日
	 * @author MBG
	 */
	String getDomain();

	/**
	 * 设置路径
	 * @param path 路径
	 * 2022年8月21日
	 * @author MBG
	 */
	void setPath(String path);

	/**
	 * 返回路径
	 * @return 路径
	 * 2022年8月21日
	 * @author MBG
	 */
	String getPath();

	/**
	 * 设置注释
	 * @param comment 注释
	 * 2022年8月21日
	 * @author MBG
	 */
	void setComment(String comment);

	/**
	 * 返回注释
	 * @return 注释
	 * 2022年8月21日
	 * @author MBG
	 */
	String getComment();

	/**
	 * 设置是否只存在于通信层
	 * @param httpOnly 是否只存在于通信层
	 * 2022年8月21日
	 * @author MBG
	 */
	void setHttpOnly(boolean httpOnly);

	/**
	 * 返回是否只存在于通信层
	 * @return 是否只存在于通信层
	 * 2022年8月21日
	 * @author MBG
	 */
	boolean isHttpOnly();

	/**
	 * 设置是否为安全会话
	 * @param secure 是否为安全会话
	 * 2022年8月21日
	 * @author MBG
	 */
	void setSecure(boolean secure);

	/**
	 * 返回是否为安全会话
	 * @return 是否为安全会话
	 * 2022年8月21日
	 * @author MBG
	 */
	boolean isSecure();

	/**
	 * 设置生存周期
	 * @param maxAge 生存周期（秒）
	 * 2022年8月21日
	 * @author MBG
	 */
	void setMaxAge(int maxAge);

	/**
	 * 返回生存周期
	 * @return 生存周期（秒）
	 * 2022年8月21日
	 * @author MBG
	 */
	int getMaxAge();
}
